<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::Pegasos&lt; VectorType &gt; Class Template Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_pegasos.html">Pegasos</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_pegasos-members.html">List of all members</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::Pegasos&lt; VectorType &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classshark_1_1_pegasos.html" title="Pegasos solver for linear (binary) support vector machines.">Pegasos</a> solver for linear (binary) support vector machines.  
 <a href="classshark_1_1_pegasos.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_pegasos_8h_source.html">shark/Algorithms/Pegasos.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac4d5f50755e24ff805700dd1102a3aca" id="r_ac4d5f50755e24ff805700dd1102a3aca"><td class="memTemplParams" colspan="2">template&lt;class WeightType &gt; </td></tr>
<tr class="memitem:ac4d5f50755e24ff805700dd1102a3aca"><td class="memTemplItemLeft" align="right" valign="top">static std::size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classshark_1_1_pegasos.html#ac4d5f50755e24ff805700dd1102a3aca">solve</a> (<a class="el" href="classshark_1_1_labeled_data.html">LabeledData</a>&lt; <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a>, unsigned int &gt; const &amp;data, double C, WeightType &amp;w, std::size_t batchsize=1, double varepsilon=0.001)</td></tr>
<tr class="memdesc:ac4d5f50755e24ff805700dd1102a3aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve the primal SVM problem.  <br /></td></tr>
<tr class="separator:ac4d5f50755e24ff805700dd1102a3aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:aaae1ce4a6bf53bb5733bf5f2f692efbb" id="r_aaae1ce4a6bf53bb5733bf5f2f692efbb"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_pegasos.html#aaae1ce4a6bf53bb5733bf5f2f692efbb">lg</a> (<a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> const &amp;x, unsigned int y, double f, <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> &amp;gradient)</td></tr>
<tr class="separator:aaae1ce4a6bf53bb5733bf5f2f692efbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a>&gt;<br />
class shark::Pegasos&lt; VectorType &gt;</div><p><a class="el" href="classshark_1_1_pegasos.html" title="Pegasos solver for linear (binary) support vector machines.">Pegasos</a> solver for linear (binary) support vector machines. </p>

<p class="definition">Definition at line <a class="el" href="_pegasos_8h_source.html#l00054">54</a> of file <a class="el" href="_pegasos_8h_source.html">Pegasos.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aaae1ce4a6bf53bb5733bf5f2f692efbb" name="aaae1ce4a6bf53bb5733bf5f2f692efbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaae1ce4a6bf53bb5733bf5f2f692efbb">&#9670;&#160;</a></span>lg()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classshark_1_1_pegasos.html">shark::Pegasos</a>&lt; <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> &gt;::lg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> const &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> &amp;&#160;</td>
          <td class="paramname"><em>gradient</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_pegasos_8h_source.html#l00161">161</a> of file <a class="el" href="_pegasos_8h_source.html">Pegasos.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_pegasos.html#ac4d5f50755e24ff805700dd1102a3aca">shark::Pegasos&lt; VectorType &gt;::solve()</a>.</p>

</div>
</div>
<a id="ac4d5f50755e24ff805700dd1102a3aca" name="ac4d5f50755e24ff805700dd1102a3aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4d5f50755e24ff805700dd1102a3aca">&#9670;&#160;</a></span>solve()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> &gt; </div>
<div class="memtemplate">
template&lt;class WeightType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::size_t <a class="el" href="classshark_1_1_pegasos.html">shark::Pegasos</a>&lt; <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a> &gt;::solve </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_labeled_data.html">LabeledData</a>&lt; <a class="el" href="_c_svm_linear_8cpp.html#ab106d665148183a2dc94dcf8716c9203">VectorType</a>, unsigned int &gt; const &amp;&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>C</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">WeightType &amp;&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>batchsize</em> = <code>1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>varepsilon</em> = <code>0.001</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Solve the primal SVM problem. </p>
<p>In addition to "standard" <a class="el" href="classshark_1_1_pegasos.html" title="Pegasos solver for linear (binary) support vector machines.">Pegasos</a> this solver checks a meaningful stopping criterion.</p>
<p>The function returns the number of model predictions during training (this is comparable to SMO iterations). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>training data  </td></tr>
    <tr><td class="paramname">C</td><td>SVM regularization parameter  </td></tr>
    <tr><td class="paramname">w</td><td>weight vector  </td></tr>
    <tr><td class="paramname">batchsize</td><td>number of samples in each gradient estimate  </td></tr>
    <tr><td class="paramname">varepsilon</td><td>solution accuracy (factor by which the primal gradient should be reduced) </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_pegasos_8h_source.html#l00065">65</a> of file <a class="el" href="_pegasos_8h_source.html">Pegasos.h</a>.</p>

<p class="reference">References <a class="el" href="namespaceshark_1_1random.html#aa64d4174eaf7111b03e0504eaa56b666">shark::random::discrete()</a>, <a class="el" href="classshark_1_1_pegasos.html#aaae1ce4a6bf53bb5733bf5f2f692efbb">shark::Pegasos&lt; VectorType &gt;::lg()</a>, <a class="el" href="group__shark__globals.html#ga5333445992cd6b14392cd80a1ab5403c">shark::LabeledData&lt; InputT, LabelT &gt;::numberOfElements()</a>, and <a class="el" href="_exception_8h.html#a73abb5049a0168d72a48e72dda41708b">SHARK_ASSERT</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Algorithms/<a class="el" href="_pegasos_8h_source.html">Pegasos.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
